<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>gnome-init</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="GNOME Library Reference Manual">
<link rel="up" href="ch01.html" title="Initializing Applications and Starting Programs">
<link rel="prev" href="libgnome-gnome-program.html" title="gnome-program">
<link rel="next" href="libgnome-gnome-exec.html" title="gnome-exec">
<meta name="generator" content="GTK-Doc V1.16 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="libgnome-gnome-program.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">GNOME Library Reference Manual</th>
<td><a accesskey="n" href="libgnome-gnome-exec.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#libgnome-gnome-init.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#libgnome-gnome-init.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="libgnome-gnome-init"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libgnome-gnome-init.top_of_page"></a>gnome-init</span></h2>
<p>gnome-init — Functions used during initialisation of libgnome and other platform libraries.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="libgnome-gnome-init.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include &lt;libgnome/libgnome.h&gt;

#define             <a class="link" href="libgnome-gnome-init.html#LIBGNOME-MODULE:CAPS" title="LIBGNOME_MODULE">LIBGNOME_MODULE</a>

const <a class="link" href="libgnome-gnome-program.html#GnomeModuleInfo" title="struct GnomeModuleInfo"><span class="returnvalue">GnomeModuleInfo</span></a> * <a class="link" href="libgnome-gnome-init.html#libgnome-module-info-get" title="libgnome_module_info_get ()">libgnome_module_info_get</a>        (<em class="parameter"><code><span class="type">void</span></code></em>);
const <a class="link" href="libgnome-gnome-program.html#GnomeModuleInfo" title="struct GnomeModuleInfo"><span class="returnvalue">GnomeModuleInfo</span></a> *  <a class="link" href="libgnome-gnome-init.html#gnome-bonobo-module-info-get" title="gnome_bonobo_module_info_get ()">gnome_bonobo_module_info_get</a>   (<em class="parameter"><code><span class="type">void</span></code></em>);

const <span class="returnvalue">char</span> *        <a class="link" href="libgnome-gnome-init.html#gnome-user-dir-get" title="gnome_user_dir_get ()">gnome_user_dir_get</a>                  (<em class="parameter"><code><span class="type">void</span></code></em>);
const <span class="returnvalue">char</span> *        <a class="link" href="libgnome-gnome-init.html#gnome-user-private-dir-get" title="gnome_user_private_dir_get ()">gnome_user_private_dir_get</a>          (<em class="parameter"><code><span class="type">void</span></code></em>);
const <span class="returnvalue">char</span> *        <a class="link" href="libgnome-gnome-init.html#gnome-user-accels-dir-get" title="gnome_user_accels_dir_get ()">gnome_user_accels_dir_get</a>           (<em class="parameter"><code><span class="type">void</span></code></em>);
</pre>
</div>
<div class="refsect1">
<a name="libgnome-gnome-init.description"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1">
<a name="libgnome-gnome-init.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="LIBGNOME-MODULE:CAPS"></a><h3>LIBGNOME_MODULE</h3>
<pre class="programlisting">#define LIBGNOME_MODULE libgnome_module_info_get()
</pre>
<p>
This macro wraps the call to <a class="link" href="libgnome-gnome-init.html#libgnome-module-info-get" title="libgnome_module_info_get ()"><code class="function">libgnome_module_info_get()</code></a> and is the usual way of
retrieving the <a class="link" href="libgnome-gnome-program.html#GnomeModuleInfo" title="struct GnomeModuleInfo"><span class="type">GnomeModuleInfo</span></a> returned by this function.
</p>
</div>
<hr>
<div class="refsect2">
<a name="libgnome-module-info-get"></a><h3>libgnome_module_info_get ()</h3>
<pre class="programlisting">const <a class="link" href="libgnome-gnome-program.html#GnomeModuleInfo" title="struct GnomeModuleInfo"><span class="returnvalue">GnomeModuleInfo</span></a> * libgnome_module_info_get        (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Retrieves the current libgnome version and the modules it depends on.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a new <a class="link" href="libgnome-gnome-program.html#GnomeModuleInfo" title="struct GnomeModuleInfo"><span class="type">GnomeModuleInfo</span></a> structure describing the version and
the versions of the dependents.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-bonobo-module-info-get"></a><h3>gnome_bonobo_module_info_get ()</h3>
<pre class="programlisting">const <a class="link" href="libgnome-gnome-program.html#GnomeModuleInfo" title="struct GnomeModuleInfo"><span class="returnvalue">GnomeModuleInfo</span></a> *  gnome_bonobo_module_info_get   (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Retrieves the bonobo module version and indicate that it requires the current
libgnome and its dependencies (although libbonobo does not depend on
libgnome, libbonoboui does and this will also be initialised when
initialising a GNOME app).
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a new <a class="link" href="libgnome-gnome-program.html#GnomeModuleInfo" title="struct GnomeModuleInfo"><span class="type">GnomeModuleInfo</span></a> structure describing the version of the
bonobo modules and its dependents.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-user-dir-get"></a><h3>gnome_user_dir_get ()</h3>
<pre class="programlisting">const <span class="returnvalue">char</span> *        gnome_user_dir_get                  (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Retrieves the user-specific directory for GNOME apps to use ($HOME/.gnome2
is the usual GNOME 2 value).
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>An absolute path to the directory.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-user-private-dir-get"></a><h3>gnome_user_private_dir_get ()</h3>
<pre class="programlisting">const <span class="returnvalue">char</span> *        gnome_user_private_dir_get          (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Differs from <a class="link" href="libgnome-gnome-init.html#gnome-user-dir-get" title="gnome_user_dir_get ()"><code class="function">gnome_user_dir_get()</code></a> in that the directory returned here will
have had permissions of 0700 (rwx------) enforced when it was created.  Of
course, the permissions may have been altered since creation, so care still
needs to be taken.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>An absolute path to the user-specific private directory that GNOME
apps can use.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-user-accels-dir-get"></a><h3>gnome_user_accels_dir_get ()</h3>
<pre class="programlisting">const <span class="returnvalue">char</span> *        gnome_user_accels_dir_get           (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Retrieves the user-specific directory that stores the keyboard shortcut files
for each GNOME app. Note that most applications should be using GConf for
storing this information, but it may be necessary to use the
<a class="link" href="libgnome-gnome-init.html#gnome-user-accels-dir-get" title="gnome_user_accels_dir_get ()"><code class="function">gnome_user_accels_dir_get()</code></a> directory for legacy applications.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The absolute path to the directory.</td>
</tr></tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.16</div>
</body>
</html>